\nThe action service provides extension points for pluggable actions and\nfilters and manage UI type action compatibility (since 5.6)\n
\nActions are commands that can be accessed and triggered from the site pages.\nTheir visibility is adapted to the current user and site possibilities using\nfilters.\n
", "extensionPoints": [ { "@type": "NXExtensionPoint", "componentId": "org.nuxeo.ecm.platform.actions.ActionService", "descriptors": [ "org.nuxeo.ecm.platform.actions.DefaultActionFilter", "org.nuxeo.ecm.platform.actions.FilterFactory" ], "documentation": "\n An action filter is a set of rules that will apply - or not - given an\n action and a context.\n\n Filter properties :\n\n - id: will be used ot identify the filter from actions definitions.\n\n - rules: set of rules composing the filter\n\n\n The default filter implementation uses filter rules with the following\n properties:\n\n - grant: boolean indicating whether this is a granting rule or a denying\n rule.\n\n - permission: permission like \"Write\" that will be checked on the context\n for the given user. A rule can hold several permissions: it applies if\n user holds at least one of them.\n\n - facet: facet like \"Folderish\" that can be set on the document type\n ({@see org.nuxeo.ecm.core.schema.types.Type}) to desribe the document type\n genral behaviour. A rule can hold several facets: it applies if current\n document in context has at least one of them.\n\n - group: group like \"members\" to check against current user in context. A rule\n can hold several groups: it applies if current user is in one of them.\n\n - condition: expression that can be evaluated against the current context.\n A rule can hold several conditions; it applies if at least one of the conditions\n is verified. The condition can be of the form #{somevar} or #{somevar.somemethod},\n or #{somevar.somemethod(arg)}, in which case it will be interpreted a Seam expression,\n otherwise it will be interpreted as a Jexl expression. A reference for Jexl can be found at\n http://commons.apache.org/jexl/reference/syntax.html\n The Jexl context for the expression contains the variables \"document\", \"principal\",\n and \"SeamContext\".\n\n - type: document type to check against current document in context. A rule\n can hold several types: it applies if current document is one of them. The\n fake 'Server' type is used to check the server context.\n\n - schema: document schema to check against current document in context. A\n rule can hold several schemas: it applies if current document has one of\n them.\n\n A filter is granting access to an action if, among its rules, no denying\n rule is found and at least one granting rule is found. If no rule is set,\n it is granted.\n\n Custom filters can be defined on the extension point, provided they follow\n the {@see org.nuxeo.ecm.platform.actions.ActionFilter} interface, using\n the following syntax:\n\n\n \n\n\n Example of action filter using default filter implementation:\n\n \n \n \n Write \n Folderish \n condition \n Workspace \n Section \n \n \n condition 1 \n condition 2 \n \n \n\n",
"documentationHtml": "\nAn action filter is a set of rules that will apply - or not - given an\naction and a context.\n
\nFilter properties :\n
\n- id: will be used ot identify the filter from actions definitions.\n
\n- rules: set of rules composing the filter\n
\nThe default filter implementation uses filter rules with the following\nproperties:\n
\n- grant: boolean indicating whether this is a granting rule or a denying\nrule.\n
\n- permission: permission like "Write" that will be checked on the context\nfor the given user. A rule can hold several permissions: it applies if\nuser holds at least one of them.\n
\n- facet: facet like "Folderish" that can be set on the document type\n({@see org.nuxeo.ecm.core.schema.types.Type}) to desribe the document type\ngenral behaviour. A rule can hold several facets: it applies if current\ndocument in context has at least one of them.\n
\n- group: group like "members" to check against current user in context. A rule\ncan hold several groups: it applies if current user is in one of them.\n
\n- condition: expression that can be evaluated against the current context.\nA rule can hold several conditions; it applies if at least one of the conditions\nis verified. The condition can be of the form #{somevar} or #{somevar.somemethod},\nor #{somevar.somemethod(arg)}, in which case it will be interpreted a Seam expression,\notherwise it will be interpreted as a Jexl expression. A reference for Jexl can be found at\nhttp://commons.apache.org/jexl/reference/syntax.html\nThe Jexl context for the expression contains the variables "document", "principal",\nand "SeamContext".\n
\n- type: document type to check against current document in context. A rule\ncan hold several types: it applies if current document is one of them. The\nfake 'Server' type is used to check the server context.\n
\n- schema: document schema to check against current document in context. A\nrule can hold several schemas: it applies if current document has one of\nthem.\n
\nA filter is granting access to an action if, among its rules, no denying\nrule is found and at least one granting rule is found. If no rule is set,\nit is granted.\n
\nCustom filters can be defined on the extension point, provided they follow\nthe {@see org.nuxeo.ecm.platform.actions.ActionFilter} interface, using\nthe following syntax:\n
\n
<object class="my.package.MyFilter"/>\n\nExample of action filter using default filter implementation:\n
\n
<filter id="theFilter">\n <rule grant="">\n <permission>Write</permission>\n <facet>Folderish</facet>\n <condition>condition</condition>\n <type>Workspace</type>\n <type>Section</type>\n </rule>\n <rule grant="false">\n <condition>condition 1</condition>\n <condition>condition 2</condition>\n </rule>\n </filter>\n\n \n VIEW_ACTION_LIST \n rights \n \n /incl/fancybox.xhtml \n \n item1 \n item2 \n \n \n mySubPropValue \n \n \n \n \n SUBVIEW_UPPER_LIST \n create \n \n \n SUBVIEW_UPPER_LIST \n \n \n AddChildren \n SectionRoot \n \n \n \n\n\n\n Actions extension point provides mergeing features: you can change an\n existing action definition in your custom extension point provided you use\n the same identifier.\n\n \n",
"documentationHtml": "\nAn action is defined by the following properties:\n
\n- id: string identifying the action\n
\n- label: the action name\n
\n- help: the action help message\n
\n- link: string representing the command the action will trigger\n
\n- category: a string useful to group actions that will be rendered in the\nsame area of a page. An action can define several categories.\n
\n- filter-ids: id of a filter that will be used to control the action\nvisibility. An action can have several filters: it is visible if all its\nfilters grant the access.\n
\n- filter: a filter definition can be done directly within the action\ndefinition. It is a filter like others and can be referred by other\nactions.\n
\n- icon: the optional icon path for this action\n
\n- confirm: an optional javascript confirmation string that can be\ntriggered when executing the command.\n
\n- enabled: boolean indicating whether the action is currently active. This\ncan be used to hide existing actions when customizing the site behaviour.\n
\n- order: an optional integer used to sort actions within the same\ncategory. This attribute may be depracated in the future.\n
\n- immediate: an optional boolean (available since 5.4.2) that makes it\npossible to call command actions without validating the enclosing form.\n
\n- type: the UI type action (available since 5.6)\n
\nUI Type properties, defined within a "properties" tag:\n- property: the property value\n- name: the property name\n
\nProperties also accept list or map-like values.\n
\nBefore 5.6, it is important to understand that an action does *not*\ndefine the way it will be rendered: this is left to pages, templates\nand other components displaying it. Most of the time, actions will be\nrendered as command link or command buttons.\n
\nSince 5.6, the template /incl/action/generic_action_template.xhtml handles\nrendering of an action depending on its type.\n
\nExamples:\n
\n
<action enabled="true" icon="/icons/file.gif" id="TAB_RIGHTS"\n label="action.view.rights"\n link="/incl/tabs/document_rights.xhtml" type="fancybox">\n <category>VIEW_ACTION_LIST</category>\n <filter-id>rights</filter-id>\n <properties>\n <property name="url">/incl/fancybox.xhtml</property>\n <propertyList name="myListProp">\n <value>item1</value>\n <value>item2</value>\n </propertyList>\n <propertyMap name="myMapProp">\n <property name="mySubProp">mySubPropValue</property>\n </propertyMap>\n </properties>\n </action>\n <action enabled="true" icon="/icons/action_add_file.gif"\n id="newFile" label="action.new.file" link="create_file" type="button">\n <category>SUBVIEW_UPPER_LIST</category>\n <filter-id>create</filter-id>\n </action>\n <action enabled="true" icon="/icons/action_add.gif" id="newSection"\n label="command.create.section"\n link="#{documentActions.createDocument('Section')}" type="icon">\n <category>SUBVIEW_UPPER_LIST</category>\n <filter id="newSection">\n <rule grant="true">\n <permission>AddChildren</permission>\n <type>SectionRoot</type>\n </rule>\n </filter>\n </action>\n\nActions extension point provides mergeing features: you can change an\nexisting action definition in your custom extension point provided you use\nthe same identifier.\n
", "hierarchyPath": "/grp:org.nuxeo.ecm.platform/grp:org.nuxeo.ecm.actions/org.nuxeo.ecm.actions/org.nuxeo.ecm.platform.actions.ActionService/ExtensionPoints/org.nuxeo.ecm.platform.actions.ActionService--actions", "id": "org.nuxeo.ecm.platform.actions.ActionService--actions", "label": "actions (org.nuxeo.ecm.platform.actions.ActionService)", "name": "actions", "version": "2021.52.8" }, { "@type": "NXExtensionPoint", "componentId": "org.nuxeo.ecm.platform.actions.ActionService", "descriptors": [ "org.nuxeo.ecm.platform.actions.TypeCompatibility" ], "documentation": "\n Action compatibility type (since 5.6) defining the UI type action\n from deprecated action category:\n\n - category: category action\n\n - type:\n UI action type\n\n Examples:\n\n\n \n DOCUMENT_UPPER_ACTION \n DOCUMENT_HEADER_ACTIONS_LIST \n \n \n DEFAULT_LIST \n CLIPBOARD_LIST \n \n \n CURRENT_SELECTION_COPY \n CLIPBOARD_PASTE \n CURRENT_SELECTION_ADDTOLIST \n CURRENT_SELECTION_TRASH \n CREATE_DOCUMENT_FORM \n EDIT_DOCUMENT_FORM \n \n \n USER_SERVICES \n USER_MENU_ACTIONS \n \n \n DOCUMENT_HEADER_ACTIONS_LIST_HREF \n \n\n",
"documentationHtml": "\nAction compatibility type (since 5.6) defining the UI type action\nfrom deprecated action category:\n
\n- category: category action\n
\n- type:\nUI action type\n
\nExamples:\n
\n
<typeCompatibility type="link_icon">\n <category>DOCUMENT_UPPER_ACTION</category>\n <category>DOCUMENT_HEADER_ACTIONS_LIST</category>\n </typeCompatibility>\n <typeCompatibility type="link_icon_text">\n <category>DEFAULT_LIST</category>\n <category>CLIPBOARD_LIST</category>\n </typeCompatibility>\n <typeCompatibility type="button">\n <category>CURRENT_SELECTION_COPY</category>\n <category>CLIPBOARD_PASTE</category>\n <category>CURRENT_SELECTION_ADDTOLIST</category>\n <category>CURRENT_SELECTION_TRASH</category>\n <category>CREATE_DOCUMENT_FORM</category>\n <category>EDIT_DOCUMENT_FORM</category>\n </typeCompatibility>\n <typeCompatibility type="link">\n <category>USER_SERVICES</category>\n <category>USER_MENU_ACTIONS</category>\n </typeCompatibility>\n <typeCompatibility type="bare_link">\n <category>DOCUMENT_HEADER_ACTIONS_LIST_HREF</category>\n </typeCompatibility>\n\n \n \n\n Example of action filter using default filter implementation:\n\n \n \n \n Write \n Folderish \n condition \n Workspace \n Section \n \n \n condition 1 \n condition 2 \n \n \n \n \n \n VIEW_ACTION_LIST \n rights \n \n /incl/fancybox.xhtml \n \n item1 \n item2 \n \n \n mySubPropValue \n \n \n \n\n \n SUBVIEW_UPPER_LIST \n create \n \n\n \n SUBVIEW_UPPER_LIST \n \n \n AddChildren \n SectionRoot \n \n \n \n \n\n Actions extension point provides mergeing features: you can change an\n existing action definition in your custom extension point provided you use\n the same identifier.\n\n \n \n DOCUMENT_UPPER_ACTION \n DOCUMENT_HEADER_ACTIONS_LIST \n \n \n DEFAULT_LIST \n CLIPBOARD_LIST \n \n \n CURRENT_SELECTION_COPY \n CLIPBOARD_PASTE \n CURRENT_SELECTION_ADDTOLIST \n CURRENT_SELECTION_TRASH \n CREATE_DOCUMENT_FORM \n EDIT_DOCUMENT_FORM \n \n \n USER_SERVICES \n USER_MENU_ACTIONS \n \n \n DOCUMENT_HEADER_ACTIONS_LIST_HREF \n \n \n\n